docs(cli): update latest cli documentation #3424
Conversation
asyncapi-bot
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
WalkthroughThe pull request updates the documentation for the AsyncAPI CLI, reflecting changes in versioning and command availability. The version number has been increased from Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
asyncapi-bot
requested review from
devilkiller-ag,
sambhavgupta0705,
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
markdown/docs/tools/cli/usage.md (2)
384-399: Add language specifier to the code block.The code block is missing a language specifier which helps with syntax highlighting.
-``` +```sh-session USAGE $ asyncapi format [SPEC-FILE] -f yaml|yml|json [-h] [-o <value>]🧰 Tools
🪛 Markdownlint (0.35.0)
384-384: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
740-757: Add language specifier to the code block.The code block is missing a language specifier which helps with syntax highlighting.
-``` +```sh-session USAGE $ asyncapi pretty SPEC-FILE [-o <value>]🧰 Tools
🪛 Markdownlint (0.35.0)
740-740: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
markdown/docs/tools/cli/usage.md(28 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
markdown/docs/tools/cli/usage.md
384-384: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
740-740: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (3)
markdown/docs/tools/cli/usage.md (3)
30-30: LGTM: Version update is consistent with the PR objectives.
The version update from 2.8.1 to 2.10.0 is correctly reflected in the documentation.
55-55: LGTM: New commands are properly added to the command list.
The new commands format and pretty are correctly added to the alphabetically sorted command list.
Also applies to: 64-64
380-401: LGTM: New command documentation is well-structured.
The documentation for the new commands format and pretty follows the established pattern and includes all necessary information:
- Command syntax
- Arguments
- Flags
- Description
- Examples (for format)
Also applies to: 736-759
🧰 Tools
🪛 Markdownlint (0.35.0)
384-384: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3424--asyncapi-website.netlify.app/ |
asyncapi-bot
deleted the
update-cli-docs-93ee631d3bc118d1ad187383988a0fcda1099fde
branch
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3424 +/- ##
=======================================
Coverage 67.77% 67.77%
=======================================
Files 21 21
Lines 664 664
=======================================
Hits 450 450
Misses 214 214 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
1 similar comment
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3424 +/- ##
=======================================
Coverage 67.77% 67.77%
=======================================
Files 21 21
Lines 664 664
=======================================
Hits 450 450
Misses 214 214 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit
asyncapi format [SPEC-FILE]andasyncapi pretty SPEC-FILEfor document conversion and formatting.